home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Applications 2002 November / SGI IRIX 6.5 Applications 2002 November.iso / dev / insight_dev.idb / usr / share / Insight / bin / gifcomment.z / gifcomment
Text File  |  2002-10-15  |  9KB  |  344 lines
  1. #!/usr/bin/perl5
  2.  
  3. # Copyright 2002, Silicon Graphics, Inc.
  4. # All Rights Reserved.
  5. #
  6. # This is UNPUBLISHED PROPRIETARY SOURCE CODE of Silicon Graphics, Inc.;
  7. # the contents of this file may not be disclosed to third parties, copied or
  8. # duplicated in any form, in whole or in part, without the prior written
  9. # permission of Silicon Graphics, Inc.
  10. #
  11. # RESTRICTED RIGHTS LEGEND:
  12. # Use, duplication or disclosure by the Government is subject to restrictions
  13. # as set forth in subdivision (c)(1)(ii) of the Rights in Technical Data
  14. # and Computer Software clause at DFARS 252.227-7013, and/or in similar or
  15. # successor clauses in the FAR, DOD or NASA FAR Supplement. Unpublished -
  16. # rights reserved under the Copyright Laws of the United States.
  17.  
  18. ##########################################################################
  19. #
  20. # Read and set comments in a GIF file
  21. #
  22. # http://www.dcs.ed.ac.uk/home/mxr/gfx/2d/GIF89a.txt
  23. #
  24. # Version 1.0 - 12/3/01
  25. #
  26. ##########################################################################
  27.  
  28. # Global array to store existing comment information
  29. @g_comments = ();
  30.  
  31. undef $new_comment;
  32. $gif_file = '';
  33.  
  34. while($arg = shift(@ARGV)) {
  35.     if($arg eq '-c') {
  36.         $new_comment = shift(@ARGV);
  37.     } elsif($arg eq '-h') {
  38.         ShowUsage();
  39.         exit;
  40.     } elsif($arg =~ m#^-#) {
  41.         print STDERR "Unknown argument '$arg'\n\n";
  42.         ShowUsage();
  43.         exit(1);
  44.     } else {
  45.         $gif_file = $arg;
  46.         last;
  47.     }
  48. } 
  49.  
  50. if($gif_file eq '') {
  51.     ShowUsage();
  52.     exit(1);
  53. } elsif(! -e $gif_file) {
  54.     print STDERR "GIF file '$gif_file' doesn't exist.\n\n";
  55.     ShowUsage();
  56.     exit(1);
  57. }
  58.  
  59. open(GIF, $gif_file) || die "Can't open '$gif_file'\n";
  60.  
  61. my(%info) = ReadFileHeader();
  62.  
  63. SkipColorMap($info{'color_map_size'}) if($info{'global_colormap'} == 1);
  64.  
  65. my($image_start) = FindImageDescriptorAndComments();
  66.  
  67. close(GIF);
  68.  
  69. if(defined($new_comment)) {
  70.     InsertComment($gif_file, $new_comment, $image_start, @g_comments);
  71. } else {
  72.     ShowComments(@g_comments);
  73. }
  74.  
  75. ##########################################################################
  76. #
  77. # The Header of the file contains two 3 byte fields.
  78. # Bytes 0-2 - 'GIF' (GIF file identifier)
  79. # Bytes 3-5 - version number (either '87a' or '89a')
  80. #
  81. # The Logical Screen Descriptor is located directly after the Header.
  82. # It is a seven byte block orginized as:
  83. #
  84. # Bytes 0 & 1 - width (16 bit little-endian)
  85. # Bytes 2 & 3 - height (16 bit little-endian)
  86. # Byte 4 - four fields packed together
  87. #    1 bit  - Global Color Table Flag (bit 7)
  88. #    3 bits - Color Resolution
  89. #    1 bit  - Sort Flag
  90. #    3 bits - Size of the Global Color Table (bits 0-2)
  91. # Byte 5 - Background Color Index
  92. # Byte 6 - Pixel Aspect Ratio
  93. #
  94. # Returns a hash table with fields for each piece of information found.
  95. #
  96. ##########################################################################
  97. sub ReadFileHeader {
  98.     my($tmp, $tmp_packed) = '';
  99.     my(%info) = ();
  100.  
  101.     read(GIF, $tmp, 3);
  102.     if($tmp ne 'GIF') {
  103.         die "This is not a GIF file.\n";
  104.     }
  105.  
  106.     read(GIF, $tmp, 3);
  107.     if($tmp ne '87a' && $tmp ne '89a') {
  108.         die "The version '$tmp' is invalid for a GIF file.\n";
  109.     }
  110.  
  111.     $info{'version'} = $tmp;
  112.  
  113.     # height and width are 2 byte (16 bit little-endian) numbers
  114.     read(GIF, $tmp, 2);
  115.     $info{'width'} = unpack("v", $tmp);
  116.  
  117.     read(GIF, $tmp, 2);
  118.     $info{'height'} = unpack("v", $tmp);
  119.  
  120.     read(GIF, $tmp, 1);
  121.     $tmp_packed = unpack("C", $tmp);
  122.  
  123.     $info{'color_map_size'} = 2 << ($tmp_packed & 0x07);
  124.     $info{'sort_flag'} = ($tmp_packed & 0x08) >> 3;
  125.     $info{'color_res'} = (($tmp_packed & 0x70) >> 3) + 1;
  126.     $info{'global_colormap'} = ($tmp_packed & 0x80) >> 7;
  127.  
  128.     read(GIF, $tmp, 1);
  129.     $info{'background'} = unpack("C", $tmp);
  130.  
  131.     read(GIF, $tmp, 1);
  132.     $info{'aspect_ratio'} = unpack("C", $tmp);
  133.  
  134.     return(%info);
  135. }
  136.  
  137. ##########################################################################
  138. #
  139. # Ignore the portion of the GIF file where the colormap is listed
  140. #
  141. # $colormap_size - number of colors described with RGB triplets (3 bytes)
  142. #
  143. ##########################################################################
  144. sub SkipColorMap {
  145.     my($colormap_size) = @_;
  146.  
  147.     # RGB triplets are used to describe each color
  148.     read(GIF, $tmp, 3 * $colormap_size);
  149. }
  150.  
  151. ##########################################################################
  152. #
  153. # Process the remainder of the file before the image data starts.  This
  154. # is where any comments should be located in the file.  According to the
  155. # GIF spec, comment blocks could occur after the image data, but for the
  156. # purpose of this program they can be ignored.
  157. #
  158. # Returns the location in the file where the image data begins.
  159. #
  160. ##########################################################################
  161. sub FindImageDescriptorAndComments {
  162.     my($image_start) = 0;
  163.     # or set to tell(GIF) right now
  164.  
  165.     while(read(GIF, $c, 1)) {
  166.         $c_ord = ord($c);
  167.         if($c_ord == 0x3B) {
  168.             # GIF terminator (end of file)
  169.             last;
  170.         } elsif($c_ord == 0x21) {
  171.             ProcessExtension();
  172.             next;
  173.         } elsif($c_ord == 0x2C) {
  174.             # Start of the image descriptor
  175.             $image_start = tell(GIF) - 1;
  176.             last;
  177.         } else {
  178.             print "Unknown char [$c][$c_ord]\n";
  179.             next;
  180.         }
  181.     }
  182.     return($image_start)
  183. }
  184.  
  185. ##########################################################################
  186. #
  187. # Process GIF comment extension blocks and ignore all others.  Comments
  188. # that are found will be added to the @g_comments array as a string with
  189. # three colon separated fields fields.
  190. #
  191. #    comment_start_offset:comment_length:comment_text
  192. #
  193. ##########################################################################
  194. sub ProcessExtension {
  195.     my($label, $comment, $comment_segment) = '';
  196.     my($start, $length) = 0;
  197.  
  198.     read(GIF, $label, 1);
  199.  
  200.     if(ord($label) == 0xFE) {
  201.         # Comment extension
  202.         $start = tell(GIF) - 2;
  203.         
  204.         while(GetDataBlock(\$comment_segment)) {
  205.             $comment .= $comment_segment;
  206.         }
  207.  
  208.         $length = tell(GIF) - $start;
  209.  
  210.         push(@g_comments, "$start:$length:$comment");
  211.     } else {
  212.         # Ignore other extension types
  213.  
  214.         # Graphic Control Extension - 0xF9
  215.         # Plain Text Label - 0x01
  216.         # Application Extension - 0xFF
  217.  
  218.         while(GetDataBlock()) {};
  219.     }
  220. }
  221.  
  222. ##########################################################################
  223. #
  224. # Data blocks begin with a single byte which is the length of the
  225. # data contained in the block.  Any data read will be stored in the
  226. # $buffer_ref parameter reference passed to this routine.  If the
  227. # incorrect amount of data is read, the program will exit.
  228. #
  229. # Returns the number of bytes of data read.  0 will be returned for
  230. # an empty data block.
  231. #
  232. ##########################################################################
  233. sub GetDataBlock {
  234.     my($buffer_ref) = @_;
  235.  
  236.     my($size) = 0;    
  237.  
  238.     read(GIF, $size, 1);
  239.     $size = ord($size);
  240.  
  241.     return(0) if($size == 0);
  242.  
  243.     if(read(GIF, $$buffer_ref, $size) != $size) {
  244.         die "Error reading data block.\n";
  245.     } else {
  246.         return($size);
  247.     }
  248. }
  249.  
  250. ##########################################################################
  251. #
  252. # Insert a new comment into the GIF file.  Any existing comments will
  253. # be overwritten.  The main steps used are:
  254. #    1. Read the entire GIF file into a string
  255. #    2. Strip out existing comments
  256. #    3. Print out the GIF up to the start of the image data
  257. #    4. Print out the new comment
  258. #    5. Print the remainder of the image data
  259. #
  260. ##########################################################################
  261. sub InsertComment {
  262.     my($file, $comment, $image_start, @existing_comments) = @_;
  263.  
  264.     open(GIF_IN, "$file") || die "Can't open '$file'\n";
  265.     my($f) = join('', <GIF_IN>);
  266.     close(GIF_IN);
  267.  
  268.     # Remove existing comments
  269.     foreach my $info (reverse(@existing_comments)) {
  270.         my($start, $length, $old_comment) = split(/:/, $info, 3);
  271.         substr($f, $start, $length) = "";
  272.         $image_start -= $length;        
  273.     }
  274.  
  275.     open(GIF_OUT, ">$file") || die "Can't write to '$file'\n";
  276.  
  277.     # Print the file to the point where the comment is inserted
  278.     print GIF_OUT substr($f, 0, $image_start);
  279.  
  280.     if($comment ne '') {
  281.         # Add the comment
  282.         # First print comment extension block identifier
  283.         print GIF_OUT pack("c", 0x21);
  284.         print GIF_OUT pack("c", 0xFE);
  285.  
  286.         # Break up comment into maximum 254 byte data block chunks
  287.         while(length($comment) > 254) {
  288.             print GIF_OUT pack("c", 254);
  289.             print GIF_OUT substr($comment, 0, 254);
  290.             $comment = substr($comment, 254);
  291.         }
  292.  
  293.         # Print remainder of the comment
  294.         print GIF_OUT pack("c", length($comment));
  295.         print GIF_OUT $comment;
  296.  
  297.         # Terminating empty data block for the comment
  298.         print GIF_OUT pack("c", 0x00);    
  299.     }
  300.  
  301.     # Print the remainder of the image
  302.     print GIF_OUT substr($f, $image_start);
  303.  
  304.     close(GIF_OUT);
  305. }
  306.  
  307. ##########################################################################
  308. #
  309. # Display any comments found
  310. #
  311. ##########################################################################
  312. sub ShowComments {
  313.     my(@comments) = @_;
  314.  
  315.     foreach my $info (@comments) {
  316.         my($start, $length, $comment) = split(/:/, $info, 3);
  317.         print "$comment\n";
  318.     }
  319. }
  320.  
  321. ##########################################################################
  322. #
  323. # Display usage information
  324. #
  325. ##########################################################################
  326. sub ShowUsage {
  327.  
  328.     my($name) = $0;
  329.     $name =~ s#^.*/([^/]+)$#$1#;
  330.  
  331. print <<USAGE;
  332. Usage: $name [-h] [-c comment] file
  333.  
  334.     -h = Print this usage statement
  335.  
  336.     -c = Specify a comment string to add to the GIF file
  337.  
  338. With no options, any existing comments will be shown.  When a new comment 
  339. is specified, all existing comments will be overwritten.
  340.  
  341. USAGE
  342.  
  343. }
  344.